org.eclipse.vtp.framework.engine
Class ActionDescriptor

java.lang.Object
  org.eclipse.vtp.framework.engine.ActionDescriptor

public final class ActionDescriptor
extends java.lang.Object

An object that describes an action.

Author:

Lonnie Pryor

Constructor Summary

ActionDescriptor(java.lang.String id, java.lang.String name, java.lang.Class type, boolean blocking)
Creates a new ActionDescriptor.

Method Summary

java.lang.String	getId() Returns the ID of this action.
java.lang.String	getName() Returns the name of this action.
java.lang.Class	getType() Returns the type of this action.
boolean	isBlocking() Returns true if this action is blocking.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ActionDescriptor

public ActionDescriptor(java.lang.String id,
                        java.lang.String name,
                        java.lang.Class type,
                        boolean blocking)
                 throws java.lang.IllegalArgumentException,
                        java.lang.NullPointerException

Creates a new ActionDescriptor.

Parameters:

id - The ID of this action.

name - The name of this action.

type - The type of this action.

blocking - True if this action is blocking.

Throws:

java.lang.IllegalArgumentException - If the supplied ID is empty.

java.lang.IllegalArgumentException - If the supplied name is empty.

java.lang.IllegalArgumentException - If the supplied type is not a public, concrete class with at least one public constructor or is not assignable to IAction.

java.lang.NullPointerException - If the supplied ID is null.

java.lang.NullPointerException - If the supplied name is null.

java.lang.NullPointerException - If the supplied type is null.

Method Detail

getId

public java.lang.String getId()

Returns the ID of this action.

Returns:

The ID of this action.

getName

public java.lang.String getName()

Returns the name of this action.

Returns:

The name of this action.

getType

public java.lang.Class getType()

Returns the type of this action.

Returns:

The type of this action.

isBlocking

public boolean isBlocking()

Returns true if this action is blocking.

Returns:

True if this action is blocking.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object